git clone https://github.com/hari-mutyala/jmeter-api-perf.git cd jmeter-api-perf/ docker build -t hmutyala/jmeter-api-perf . docker push hmutyala/jmeter-api-perf docker pull hmutyala/jmeter-api-perf docker run --name jmeter-api-perf hmutyala/jmeter-api-perf docker cp jmeter-api-perf:/opt/apache-jmeter-5.5/bin/reports/API_PERF_Results.zip .
Docker image for Apache JMeter.
This Docker image can be run as the jmeter command.
Find Images of this repo on Docker Hub.
Starting version 5.4 Docker builds/pushes
are executed via GitHub Workflows.
As you may have seen in the news, a new zero-day exploit has been reported against the popular Log4J2 library which can allow an attacker to remotely execute code. The vulnerability has been reported with CVE-2021-44228 against the log4j-core jar and has been fixed in Log4J v2.16.0.
JMeter, at least in versions 5 and later uses the vulnerable Log4J versions. The good news though is that the vulnerability applies only to remotely accessible Java web-services. JMeter is a commandline/GUI tool one runs internally. Still it is good practice to patch this problem.
JMeter has been updated to 5.4.2 for security CVE-2021-45046 & CVE-2021-45046.
https://jmeter.apache.org/changes.html#Non-functional%20changes
The update to 5.4.2 includes the updated Apache log4j2 to 2.16.0 (from 2.13.3), thanks for PR #51!
With the script build.sh the Docker image can be build
from the Dockerfile but this is not really necessary as
you may use your own docker build commandline. Or better: use one
of the pre-built Images from Docker Hub.
Build arguments (see build.sh) with default values if not passed to build:
- JMETER_VERSION - JMeter version, default
5.4. Use as env variable to build with another version:export JMETER_VERSION=5.4 - IMAGE_TIMEZONE - timezone of Docker image, default
"Europe/Amsterdam". Use as env variable to build with another timezone:export IMAGE_TIMEZONE="Europe/Berlin"
The Docker image will accept the same parameters as jmeter itself, assuming
you run JMeter non-GUI with -n.
There is a shorthand run.sh command. See test.sh for an example of how to call run.sh.
This is a standard facility of JMeter: settings in a JMX test script may be defined symbolically and substituted at runtime via the commandline. These are called JMeter User Defined Variables or UDVs.
See test.sh and the trivial test plan for an example of UDVs passed to the Docker image via run.sh.
See also: https://www.novatec-gmbh.de/en/blog/how-to-pass-command-line-properties-to-a-jmeter-testplan/
By default, JMeter reads out the available memory from the host machine and uses a fixed value of 80% of it as a maximum. If this causes Issues, there is the option to use environment variables to adjust the JVM memory Parameters:
JVM_XMN to adjust maximum nursery size
JVM_XMS to adjust initial heap size
JVM_XMX to adjust maximum heap size
All three use values in Megabyte range.
To run the container with custom JMeter plugins installed you need to mount a volume /plugins with the .jar files. For example:
sudo docker run --name ${NAME} -i -v ${LOCAL_PLUGINS_FOLDER}:/plugins -v ${LOCAL_JMX_WORK_DIR}:${CONTAINER_JMX_WORK_DIR} -w ${PWD} ${IMAGE} $@The ${LOCAL_PLUGINS_FOLDER} must have only .jar files. Folders and another file extensions will not be considered.
It is also possible to define an alternate location to the custom JMeter plugins folder. Simply define a environment variable called JMETER_CUSTOM_PLUGINS_FOLDER with the desired folder path like in the example bellow:
sudo docker run --name ${NAME} -i -e JMETER_CUSTOM_PLUGINS_FOLDER=/jmeter/plugins -v ${LOCAL_PLUGINS_FOLDER}:/jmeter/plugins -v ${LOCAL_JMX_WORK_DIR}:${CONTAINER_JMX_WORK_DIR} -w ${PWD} ${IMAGE} $@The Docker image built from the Dockerfile inherits from the Alpine Linux distribution:
"Alpine Linux is built around musl libc and busybox. This makes it smaller and more resource efficient than traditional GNU/Linux distributions. A container requires no more than 8 MB and a minimal installation to disk requires around 130 MB of storage. Not only do you get a fully-fledged Linux environment but a large selection of packages from the repository."
See https://hub.docker.com/_/alpine/ for Alpine Docker images.
The Docker image will install (via Alpine apk) several required packages most specificly
the OpenJDK Java JRE. JMeter is installed by simply downloading/unpacking a .tgz archive
from http://mirror.serversupportforum.de/apache/jmeter/binaries within the Docker image.
A generic entrypoint.sh is copied into the Docker image and
will be the script that is run when the Docker container is run. The
entrypoint.sh simply calls jmeter passing all argumets provided
to the Docker container, see run.sh script:
sudo docker run --name ${NAME} -i -v ${WORK_DIR}:${WORK_DIR} -w ${WORK_DIR} ${IMAGE} $@
Thanks to https://github.com/justb4/docker-jmeter/